Add `wp db status` command for database health overview by Copilot · Pull Request #307 · wp-cli/db-command

Copilot · 2026-02-01T16:05:09Z

Adds a new wp db status command that provides a consolidated view of database health and configuration information in a single command, eliminating the need to run multiple separate database commands (wp db size, wp db tables, wp db prefix, wp db check).

Implementation

New status() method in DB_Command class that works without loading WordPress
- Uses raw SQL queries via self::run() method instead of $wpdb for database information
- Queries information_schema.TABLES for table count, size, engine, charset, and collation
- Gets table prefix from global $table_prefix variable (wp-config.php)
- Runs mysqlcheck for health status
- Detects mixed engines/charsets/collations across tables
- Formats output as aligned key-value pairs using data-driven approach
- Supports --dbuser, --dbpass, and --defaults options for authentication
Command registration in composer.json
Comprehensive Behat test coverage with regex matching for dynamic values and credential option testing

Key Features

Works without loading WordPress: Operates at after_wp_config_load level (class default), similar to wp db query
Functions before WordPress installation: Provides database diagnostics even when WordPress is not fully installed
No WordPress dependencies: Uses raw SQL queries through mysql client instead of $wpdb object
Proper SQL escaping: Uses addslashes() with LIKE pattern escaping for security
Handles edge cases: NULL values, mixed configurations, empty databases, zero table count

Output Example

Database Name:     wp_cli_test
Tables:            54
Total Size:        312 KB
Prefix:            wp_
Engine:            InnoDB
Charset:           utf8mb4
Collation:         utf8mb4_unicode_ci
Check Status:      OK

Notes

Uses SI units (1000-based) for size formatting, matching existing wp db size --human-readable behavior
Detects and displays "Mixed" when tables have different engines, charsets, or collations
Suitable for automation scripts and diagnostic tools that run before WordPress initialization
Maintains consistency with other database commands in credential handling

Original prompt

This section details on the original issue you should resolve

<issue_title>Add wp db status command for quick database health overview</issue_title>
<issue_description>I would like to suggesta new WP-CLI command: wp db status

The command would provide a concise, read-only overview of the current WordPress database health and configuration in a single output, reducing the need to run multiple separate commands.

For support, debugging, and hosting diagnostics, it would be beneficial to have a single, non-destructive command that aggregates key database information into one quick report.

Currently, checking database status requires running several commands such as: wp db size, wp db tables, wp db prefix, wp db check, etc.

My Proposed Command:

wp db status

Output Example:
Database Name:     wp_mehrazmorshed
Tables:            54
Total Size:        312 MB
Prefix:            wp_
Engine:            InnoDB
Charset:           utf8mb4
Collation:         utf8mb4_unicode_ci
Check Status:      OK
```</issue_description>

## Comments on the Issue (you are @copilot in this section)

<comments>
<comment_new><author>@ernilambar</author><body>
It will be included in next "3.0.0" version.</body></comment_new>
<comment_new><author>@swissspidy</author><body>
Yeah you can already try it out in the nightly release.

One difference is that the site-health command involves loading WordPress, whereas the db commands usually also work when WordPress is not even installed yet.</body></comment_new>
<comment_new><author>@ernilambar</author><body>
Although database info is available from "site-health" command I am positive is adding specific db command which gives info without loading whole WordPress. It would be helpful in scripting.</body></comment_new>
</comments>

Fixes Add wp db status command for quick database health overview #306

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: swissspidy <841956+swissspidy@users.noreply.github.com>

codecov · 2026-02-01T16:21:17Z

Codecov Report

❌ Patch coverage is 98.03922% with 1 line in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
src/DB_Command.php	98.03%	1 Missing ⚠️

📢 Thoughts on this report? Let us know!

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Co-authored-by: swissspidy <841956+swissspidy@users.noreply.github.com>

Copilot

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated no new comments.

Suppressed comments (6)

src/DB_Command.php:1481

The database size query also ignores $exit_code/$stderr from self::run(). On mysql failures this can lead to $db_size being reported as 0 B instead of returning an error.

		list( $stdout, $stderr, $exit_code ) = self::run(
			$command,
			array_merge( [ 'execute' => $db_size_query ], $assoc_args ),
			false
		);

src/DB_Command.php:1516

The table info query (engine/charset/collation) ignores failures from self::run(). If mysql errors here, the code will parse an empty/invalid $stdout and silently fall back to N/A, masking real connection/query issues.

		list( $stdout, $stderr, $exit_code ) = self::run(
			$command,
			array_merge( [ 'execute' => $table_info_query ], $assoc_args ),
			false
		);

src/DB_Command.php:1544

get_defaults_flag_string() mutates $assoc_args by unsetting the defaults key. Since status() calls it once when building the mysql $command and again here when building $check_command, a --defaults invocation will incorrectly end up running mysqlcheck with --no-defaults (the second call no longer sees the defaults flag). Store the defaults flag string once and reuse it for both commands (or avoid mutating $assoc_args).

			$check_command                       = sprintf(
				'/usr/bin/env %s%s %s',
				Utils\get_sql_check_command(),
				$this->get_defaults_flag_string( $assoc_args ),
				'%s'

src/DB_Command.php:1469

The first self::run() call captures $exit_code/$stderr but ignores them. If the mysql client fails (bad creds, missing client, connection error), the command will silently continue with $table_count set to 0, producing incorrect output.

		list( $stdout, $stderr, $exit_code ) = self::run(
			$command,
			array_merge( [ 'execute' => $table_count_query ], $assoc_args ),
			false
		);

src/DB_Command.php:1416

The docblock claims “If WordPress is installed, additional details are included”, but status() always prints the same fixed set of fields and does not branch on installation state. This is misleading for users reading wp help db status.

	 * This command works even when WordPress is not fully installed,
	 * providing minimal information. If WordPress is installed, additional
	 * details are included.

src/DB_Command.php:1444

status() doesn't call maybe_load_sqlite_dropin() or handle SQLite the way other db commands do (e.g. check()). As written, it will attempt to run mysql/mysqlcheck even when SQLite is the active DB engine, which will fail or produce misleading output.

This issue also appears in the following locations of the same file:

line 1465
line 1477
line 1512
line 1540

	public function status( $_, $assoc_args ) {
		global $table_prefix;

		// Get database name from constants (available after wp-config loads).
		$db_name = DB_NAME;

Initial plan

970cf3f

Copilot AI assigned Copilot and swissspidy Feb 1, 2026

Copilot started work on behalf of swissspidy February 1, 2026 16:05 View session

Copilot AI and others added 2 commits February 1, 2026 16:10

Add wp db status command implementation

0a6e265

Co-authored-by: swissspidy <841956+swissspidy@users.noreply.github.com>

Fix edge case handling for zero database size

7c06ca3

Co-authored-by: swissspidy <841956+swissspidy@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] Add wp db status command for database health overview~~ Add wp db status command for database health overview Feb 1, 2026

Copilot AI requested a review from swissspidy February 1, 2026 16:13

Copilot finished work on behalf of swissspidy February 1, 2026 16:13

swissspidy requested a review from Copilot February 2, 2026 01:50

This comment was marked as resolved.

Sign in to view

Copilot started reviewing on behalf of swissspidy February 2, 2026 01:50 View session

This comment was marked as resolved.

Sign in to view

swissspidy and others added 3 commits February 2, 2026 20:47

Update src/DB_Command.php

94d0fea

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update src/DB_Command.php

ba35677

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update src/DB_Command.php

66478f6

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Copilot started work on behalf of swissspidy February 3, 2026 02:02 View session

Fix wp db status to accept parameters and run before WordPress loads

8a0d032

Co-authored-by: swissspidy <841956+swissspidy@users.noreply.github.com>

Copilot finished work on behalf of swissspidy February 3, 2026 02:05

Small fixes

9da36cf

This comment was marked as resolved.

Sign in to view

Copilot started work on behalf of swissspidy February 4, 2026 01:58 View session

Refactor status command for better maintainability and test robustness

10a1f72

Co-authored-by: swissspidy <841956+swissspidy@users.noreply.github.com>

This comment was marked as resolved.

Sign in to view

Copilot finished work on behalf of swissspidy February 4, 2026 02:01

swissspidy marked this pull request as ready for review February 4, 2026 03:12

swissspidy requested a review from a team as a code owner February 4, 2026 03:12

Merge branch 'main' into copilot/add-wp-db-status-command

d2e9c27

Merge branch 'main' into copilot/add-wp-db-status-command

fa2545f

github-actions Bot added command:db scope:distribution state:unconfirmed labels Feb 17, 2026

swissspidy removed the state:unconfirmed label Feb 17, 2026

PHPStan fix

13d3155

This comment was marked as resolved.

Sign in to view

Copilot started work on behalf of swissspidy February 26, 2026 09:39 View session

Copilot AI and others added 2 commits February 26, 2026 09:45

Refactor wp db status to work without loading WordPress

7992729

Co-authored-by: swissspidy <841956+swissspidy@users.noreply.github.com>

Fix escaping order for LIKE pattern in table prefix

dc552dd

Co-authored-by: swissspidy <841956+swissspidy@users.noreply.github.com>

This comment was marked as resolved.

Sign in to view

swissspidy added 2 commits March 22, 2026 16:38

Merge branch 'main' into copilot/add-wp-db-status-command

8dfc5d0

Merge branch 'main' into copilot/add-wp-db-status-command

d5cb769

Copilot finished work on behalf of swissspidy July 1, 2026 08:51

ernilambar requested a review from Copilot August 2, 2026 11:39

Copilot started reviewing on behalf of ernilambar August 2, 2026 11:39 View session

Copilot AI reviewed Aug 2, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add `wp db status` command for database health overview - #307

Add `wp db status` command for database health overview#307
swissspidy with Copilot wants to merge 16 commits into
mainfrom
copilot/add-wp-db-status-command

Copilot AI commented Feb 1, 2026 •

edited

Loading

Uh oh!

codecov Bot commented Feb 1, 2026

Uh oh!

This comment was marked as resolved.

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

Copilot AI left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

Copilot AI commented Feb 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Implementation

Key Features

Output Example

Notes

My Proposed Command:

Output Example:

Uh oh!

codecov Bot commented Feb 1, 2026

Codecov Report

Uh oh!

This comment was marked as resolved.

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Copilot AI commented Feb 1, 2026 •

edited

Loading